Add elasticstack_kibana_default_data_view resource to manage default data view #1379

Copilot · 2025-10-19T22:29:37Z

Overview

This PR implements a new elasticstack_kibana_default_data_view resource that allows users to programmatically set the default Kibana data view, addressing the feature request in issue #XXX.

Previously, users could only set the default data view manually through the Kibana UI (see screenshot below). This resource enables automated management of this setting through Terraform.

Changes

New Resource: `elasticstack_kibana_default_data_view`

Schema:

data_view_id (required, string): The data view identifier to set as default
force (optional, bool, default: true): Update an existing default data view identifier
skip_delete (optional, bool, default: false): If true, the default data view will not be unset when the resource is destroyed

Example Usage:

resource "elasticstack_kibana_data_view" "my_data_view" {
  data_view = {
    title = "my-logs-*"
    name  = "My Logs Data View"
  }
}

resource "elasticstack_kibana_default_data_view" "default" {
  data_view_id = elasticstack_kibana_data_view.my_data_view.data_view.id
  force        = true
  skip_delete  = false
}

Implementation Details

API Integration: Uses the Kibana Set Default Data View and Get Default Data View APIs
CRUD Operations:
- Create/Update: Sets the specified data view as default
- Read: Retrieves and verifies the current default data view
- Delete: Conditionally unsets the default based on skip_delete flag
Framework: Built using the Terraform Plugin Framework (not SDK v2) as per repository guidelines

Files Added

internal/kibana/default_data_view/ - Complete resource implementation with CRUD operations, schema, models, and tests
examples/resources/elasticstack_kibana_default_data_view/resource.tf - Example configuration
docs/resources/kibana_default_data_view.md - Generated documentation

Testing

✅ All acceptance tests pass:

Basic create and update functionality
Skip delete behavior verification
No regressions in existing data_view resource tests

✅ Manual end-to-end testing completed and verified all scenarios:

Setting default data view
Updating to different data view
Conditional deletion behavior

Related Issues

Closes #XXX

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature] elasticstack_kibana_data_view - can't set default data view </issue_title>
<issue_description>## Implementation plan

Create a new elasticstack_kibana_default_data_view resource

Use set default data view and get default data view API operations.

The resource should define data_view_id, force, and skip_delete attributes in it's schema. If skip_delete is true then the Delete operation should be a no-op, leaving the existing default data view unchanged.

Add acceptance tests covering the resource behaviour. Use the existing elasticstack_kibana_data_view resource to create data views for testing.

Ensure you follow the Copilot instructions at all times.

Is your feature request related to a problem? Please describe.
When I have many data views, and I'd like to set only one as a default one.
It's visible in Kibana, in Data view, view:

Describe the resource you would like to have implemented.
To be able to manage Kibana automatically, the way I could manually. In case I have a lot of Spaces and DataViews.

Describe the solution you'd like
resource "elasticstack_kibana_data_view" "name" {
  data_view = {
    ...
    default = true
  }
}
Describe alternatives you've considered
REST API Call?

Additional context
Attached screenshot
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #603

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: tobio <[email protected]>

…ata-view-resource * origin/main: chore(deps): update golang:1.25.3 docker digest to bce1e7e (#1382) Clean before regenerating the client Clean before regenerating the client Use a working API spec chore(deps): update kibana-openapi-spec digest to 9b8ef82 (#1377) Include the generated client in the post upgrade task

Kushmaro · 2025-10-28T15:25:08Z

@tobio , shouldn't the default setting of a dataview be better of as a property of the dataview resource itself rather a separate resource?

Or is the API built weird here?

tobio · 2025-11-04T22:16:56Z

shouldn't the default setting of a dataview be better of as a property of the dataview resource

@Kushmaro setting the default dataview is a distinct API endpoint, rather than a property of the dataview itself, so we're partly modelling that.

We could still make this a property of the dataview resource, and just make multiple API calls, I did think about doing that, but IMO having a separate resource makes a little more sense:

The Kibana API will fail if we try to overwrite the default dataview without force=true. We could just hardcode that to true in the provider, but giving users control over that parameter allows a little extra safety on their part.
Similarly, it mostly makes sense to give users control over the 'delete' flow. Does deleting the default data view resource clear the setting in Kibana, or just leave it unmanaged?

So it feels like defining this in the dataview resource itself, actually becomes default = true, force_default = true, skip_default_delete = true which seems pretty unpleasant to me compared to an independent resource.

Kushmaro · 2025-11-10T11:01:20Z

gotcha @tobio , thanks for clarifying!
grrr our APIs are so wierd at times :(

Copilot

Pull Request Overview

This PR introduces a new elasticstack_kibana_default_data_view resource that enables programmatic management of Kibana's default data view setting through Terraform, addressing a limitation where this could previously only be configured through the Kibana UI.

Key Changes:

New resource implementation with support for setting, updating, and conditionally unsetting the default data view
Integration with Kibana's default data view API endpoints
Comprehensive acceptance tests covering basic operations, updates, skip_delete behavior, and custom space support

Reviewed Changes

Copilot reviewed 17 out of 19 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`provider/plugin_framework.go`	Registered the new default_data_view resource
`internal/kibana/default_data_view/*.go`	Complete resource implementation including CRUD operations, schema, and models
`internal/kibana/default_data_view/test_data/*.tf`	Test configurations for various scenarios
`internal/clients/kibana_oapi/data_views.go`	Added API client functions for getting and setting default data views
`examples/resources/elasticstack_kibana_default_data_view/resource.tf`	Example usage configuration
`docs/resources/kibana_default_data_view.md`	Generated resource documentation

Copilot · 2025-11-13T11:36:13Z

internal/kibana/default_data_view/schema.go

+			},
+			"force": schema.BoolAttribute{
+				MarkdownDescription: "Update an existing default data view identifier. If set to false and a default data view already exists, the operation will fail.",
+				Optional:            true,


The force attribute is missing Computed: true and a default value. According to the schema pattern and the PR description stating force defaults to true, this should include Computed: true and Default: booldefault.StaticBool(true) to match the documented behavior.

Suggested change

Optional: true,

Optional: true,

Computed: true,

Default: booldefault.StaticBool(true),

Copilot AI assigned Copilot and tobio Oct 19, 2025

Copilot started work on behalf of tobio October 19, 2025 22:29 View session

Copilot AI changed the title ~~[WIP] Add elasticstack_kibana_default_data_view resource~~ Add elasticstack_kibana_default_data_view resource to manage default data view Oct 19, 2025

Copilot AI requested a review from tobio October 19, 2025 22:57

Copilot finished work on behalf of tobio October 19, 2025 22:57

Copilot AI and others added 5 commits October 20, 2025 17:00

Initial plan

c98d112

Add kibana_default_data_view resource with CRUD operations

989dc31

Co-authored-by: tobio <[email protected]>

Fix ID consistency and generate documentation

31bdf5c

Co-authored-by: tobio <[email protected]>

Add linting fixes, example, and final documentation

8862467

Co-authored-by: tobio <[email protected]>

Make default data view API space aware

9b64020

tobio force-pushed the copilot/add-default-data-view-resource branch from b9dd33a to 9b64020 Compare October 20, 2025 06:00

Support removing the default data view

8e5e1d9

tobio requested a review from nick-benoit October 20, 2025 11:41

tobio marked this pull request as ready for review October 20, 2025 11:41

tobio added 2 commits October 21, 2025 09:18

Merge branch 'main' into copilot/add-default-data-view-resource

563d2eb

Merge branch 'main' into copilot/add-default-data-view-resource

87a2736

tobio requested a review from Copilot November 13, 2025 11:35

Copilot AI reviewed Nov 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add elasticstack_kibana_default_data_view resource to manage default data view #1379

Add elasticstack_kibana_default_data_view resource to manage default data view #1379

Uh oh!

Copilot AI commented Oct 19, 2025 •

edited

Loading

Uh oh!

Kushmaro commented Oct 28, 2025

Uh oh!

tobio commented Nov 4, 2025

Uh oh!

Kushmaro commented Nov 10, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add elasticstack_kibana_default_data_view resource to manage default data view #1379

Are you sure you want to change the base?

Add elasticstack_kibana_default_data_view resource to manage default data view #1379

Uh oh!

Conversation

Copilot AI commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Changes

New Resource: elasticstack_kibana_default_data_view

Implementation Details

Files Added

Testing

Related Issues

Comments on the Issue (you are @copilot in this section)

Uh oh!

Kushmaro commented Oct 28, 2025

Uh oh!

tobio commented Nov 4, 2025

Uh oh!

Kushmaro commented Nov 10, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Oct 19, 2025 •

edited

Loading

New Resource: `elasticstack_kibana_default_data_view`